# LeaderBoardManager.openLeaderboard
# 功能描述
打开Tap排行榜列表页面,页面显示游戏的排行榜榜单,包括总榜和好友榜,用户可切换显示两种榜单。
# 参数
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
leaderboardId | string | 是 | 排行榜ID | |
collection | string | public | 否 | 榜单类型,有效值为"friends"或"public"; 当为"friends"时需要隐私协议中添加并授权好友关系 |
callback | Object | 否 | 接口调用结果回调 |
callback:
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
success | function | 否 | 接口调用成功的回调函数 | |
fail | function | 否 | 接口调用失败的回调函数 | |
complete | function | 否 | 接口调用结束的回调函数(成功/失败都会执行) |
# 错误
1025、104、103错误码,在collection参数为"friends"时可能遇到,若遇到1025错误码,请参照权限说明部分修改小游戏后台配置。
错误码 | 错误信息 | 说明 |
---|---|---|
500001 | 排行榜 ID 未找到 | 排行榜 ID 不存在 |
500002 | 排行榜参数错误 | 排行榜 ID 与游戏不匹配 |
1025 | 小游戏没有申明使用好友关系信息 | 开发者在后台没有在隐私协议中申明使用好友关系,调用需要好友关系权限的api时会返回此错误码 |
104 | 用户未通过隐私协议 | 调用需要好友关系权限的api时,用户没有通过隐私协议则返回该错误码 |
103 | 用户未授权使用其好友关系信息 | 调用需要好友关系权限的api时,用户没有授权使用好友信息则返回该错误码 |
500201 | leaderboardId为空 | 提示传入正确的leaderboardId |
示例代码
tapLeaderboard.openLeaderboard({
leaderboardId: "your_leaderboardId",
collection: "public",
callback: {
onSuccess: function(res) {
console.log("openLeaderboard success:", res);
},
onFailure: function(code, message) {
console.error(`openLeaderboard failed: code=${code}, message=${message}`);
}
}
});